/*
 * Copyright 2013 Sigurd Randoll.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package de.digiway.rapidbreeze.server.model.storage;

/**
 * Gives concrete information about the specified URL
 *
 * @author Sigurd
 */
public interface UrlStatus {

    /**
     * Returns the filename of a file at the given URL location. If filename is
     * not supported, it may return a null value.
     *
     * @return filename or null
     */
    public String getFilename();

    /**
     * Gets the total size of the file. It may return null if the size is not
     * determinable.
     *
     * @return size or null
     */
    public Long getFileSize();

    /**
     * Returns the current {@linkplain FileStatus} of the file
     *
     * @return {@linkplain FileStatus} of the file. Never null!
     */
    public FileStatus getFileStatus();

    /**
     * Returns a string representing the MD5 hash of the file. Can return null
     * if the MD5 hash is not supported.
     *
     * @return
     */
    public String getMd5();

    /**
     * Returns the url as a string value.
     *
     * @return
     */
    public String getUrl();
}
